home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / sgbsvx.z / sgbsvx
Text File  |  1996-03-14  |  13KB  |  331 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGBSVX - use the LU factorization to compute the solution to a real
  10.      system of linear equations A * X = B, A**T * X = B, or A**H * X = B,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGBSVX( FACT, TRANS, N, KL, KU, NRHS, AB, LDAB, AFB, LDAFB,
  14.                         IPIV, EQUED, R, C, B, LDB, X, LDX, RCOND, FERR, BERR,
  15.                         WORK, IWORK, INFO )
  16.  
  17.          CHARACTER      EQUED, FACT, TRANS
  18.  
  19.          INTEGER        INFO, KL, KU, LDAB, LDAFB, LDB, LDX, N, NRHS
  20.  
  21.          REAL           RCOND
  22.  
  23.          INTEGER        IPIV( * ), IWORK( * )
  24.  
  25.          REAL           AB( LDAB, * ), AFB( LDAFB, * ), B( LDB, * ), BERR( *
  26.                         ), C( * ), FERR( * ), R( * ), WORK( * ), X( LDX, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      SGBSVX uses the LU factorization to compute the solution to a real system
  30.      of linear equations A * X = B, A**T * X = B, or A**H * X = B, where A is
  31.      a band matrix of order N with KL subdiagonals and KU superdiagonals, and
  32.      X and B are N-by-NRHS matrices.
  33.  
  34.      Error bounds on the solution and a condition estimate are also provided.
  35.  
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      The following steps are performed by this subroutine:
  39.  
  40.      1. If FACT = 'E', real scaling factors are computed to equilibrate
  41.         the system:
  42.            TRANS = 'N':  diag(R)*A*diag(C)     *inv(diag(C))*X = diag(R)*B
  43.            TRANS = 'T': (diag(R)*A*diag(C))**T *inv(diag(R))*X = diag(C)*B
  44.            TRANS = 'C': (diag(R)*A*diag(C))**H *inv(diag(R))*X = diag(C)*B
  45.         Whether or not the system will be equilibrated depends on the
  46.         scaling of the matrix A, but if equilibration is used, A is
  47.         overwritten by diag(R)*A*diag(C) and B by diag(R)*B (if TRANS='N')
  48.         or diag(C)*B (if TRANS = 'T' or 'C').
  49.  
  50.      2. If FACT = 'N' or 'E', the LU decomposition is used to factor the
  51.         matrix A (after equilibration if FACT = 'E') as
  52.            A = L * U,
  53.         where L is a product of permutation and unit lower triangular
  54.         matrices with KL subdiagonals, and U is upper triangular with
  55.         KL+KU superdiagonals.
  56.  
  57.      3. The factored form of A is used to estimate the condition number
  58.         of the matrix A.  If the reciprocal of the condition number is
  59.         less than machine precision, steps 4-6 are skipped.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      4. The system of equations is solved for X using the factored form
  75.         of A.
  76.  
  77.      5. Iterative refinement is applied to improve the computed solution
  78.         matrix and calculate error bounds and backward error estimates
  79.         for it.
  80.  
  81.      6. If equilibration was used, the matrix X is premultiplied by
  82.         diag(C) (if TRANS = 'N') or diag(R) (if TRANS = 'T' or 'C') so
  83.         that it solves the original system before equilibration.
  84.  
  85.  
  86. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  87.      FACT    (input) CHARACTER*1
  88.              Specifies whether or not the factored form of the matrix A is
  89.              supplied on entry, and if not, whether the matrix A should be
  90.              equilibrated before it is factored.  = 'F':  On entry, AFB and
  91.              IPIV contain the factored form of A.  If EQUED is not 'N', the
  92.              matrix A has been equilibrated with scaling factors given by R
  93.              and C.  AB, AFB, and IPIV are not modified.  = 'N':  The matrix A
  94.              will be copied to AFB and factored.
  95.              = 'E':  The matrix A will be equilibrated if necessary, then
  96.              copied to AFB and factored.
  97.  
  98.      TRANS   (input) CHARACTER*1
  99.              Specifies the form of the system of equations.  = 'N':  A * X = B
  100.              (No transpose)
  101.              = 'T':  A**T * X = B  (Transpose)
  102.              = 'C':  A**H * X = B  (Transpose)
  103.  
  104.      N       (input) INTEGER
  105.              The number of linear equations, i.e., the order of the matrix A.
  106.              N >= 0.
  107.  
  108.      KL      (input) INTEGER
  109.              The number of subdiagonals within the band of A.  KL >= 0.
  110.  
  111.      KU      (input) INTEGER
  112.              The number of superdiagonals within the band of A.  KU >= 0.
  113.  
  114.      NRHS    (input) INTEGER
  115.              The number of right hand sides, i.e., the number of columns of
  116.              the matrices B and X.  NRHS >= 0.
  117.  
  118.      AB      (input/output) REAL array, dimension (LDAB,N)
  119.              On entry, the matrix A in band storage, in rows 1 to KL+KU+1.
  120.              The j-th column of A is stored in the j-th column of the array AB
  121.              as follows:  AB(KU+1+i-j,j) = A(i,j) for max(1,j-
  122.              KU)<=i<=min(N,j+kl)
  123.  
  124.              If FACT = 'F' and EQUED is not 'N', then A must have been
  125.              equilibrated by the scaling factors in R and/or C.  AB is not
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              modified if FACT = 'F' or 'N', or if FACT = 'E' and EQUED = 'N'
  141.              on exit.
  142.  
  143.              On exit, if EQUED .ne. 'N', A is scaled as follows:  EQUED = 'R':
  144.              A := diag(R) * A
  145.              EQUED = 'C':  A := A * diag(C)
  146.              EQUED = 'B':  A := diag(R) * A * diag(C).
  147.  
  148.      LDAB    (input) INTEGER
  149.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  150.  
  151.      AFB     (input or output) REAL array, dimension (LDAFB,N)
  152.              If FACT = 'F', then AFB is an input argument and on entry
  153.              contains details of the LU factorization of the band matrix A, as
  154.              computed by SGBTRF.  U is stored as an upper triangular band
  155.              matrix with KL+KU superdiagonals in rows 1 to KL+KU+1, and the
  156.              multipliers used during the factorization are stored in rows
  157.              KL+KU+2 to 2*KL+KU+1.  If EQUED .ne. 'N', then AFB is the
  158.              factored form of the equilibrated matrix A.
  159.  
  160.              If FACT = 'N', then AFB is an output argument and on exit returns
  161.              details of the LU factorization of A.
  162.  
  163.              If FACT = 'E', then AFB is an output argument and on exit returns
  164.              details of the LU factorization of the equilibrated matrix A (see
  165.              the description of AB for the form of the equilibrated matrix).
  166.  
  167.      LDAFB   (input) INTEGER
  168.              The leading dimension of the array AFB.  LDAFB >= 2*KL+KU+1.
  169.  
  170.      IPIV    (input or output) INTEGER array, dimension (N)
  171.              If FACT = 'F', then IPIV is an input argument and on entry
  172.              contains the pivot indices from the factorization A = L*U as
  173.              computed by SGBTRF; row i of the matrix was interchanged with row
  174.              IPIV(i).
  175.  
  176.              If FACT = 'N', then IPIV is an output argument and on exit
  177.              contains the pivot indices from the factorization A = L*U of the
  178.              original matrix A.
  179.  
  180.              If FACT = 'E', then IPIV is an output argument and on exit
  181.              contains the pivot indices from the factorization A = L*U of the
  182.              equilibrated matrix A.
  183.  
  184.      EQUED   (input or output) CHARACTER*1
  185.              Specifies the form of equilibration that was done.  = 'N':  No
  186.              equilibration (always true if FACT = 'N').
  187.              = 'R':  Row equilibration, i.e., A has been premultiplied by
  188.              diag(R).  = 'C':  Column equilibration, i.e., A has been
  189.              postmultiplied by diag(C).  = 'B':  Both row and column
  190.              equilibration, i.e., A has been replaced by diag(R) * A *
  191.              diag(C).  EQUED is an input argument if FACT = 'F'; otherwise, it
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  203.  
  204.  
  205.  
  206.              is an output argument.
  207.  
  208.      R       (input or output) REAL array, dimension (N)
  209.              The row scale factors for A.  If EQUED = 'R' or 'B', A is
  210.              multiplied on the left by diag(R); if EQUED = 'N' or 'C', R is
  211.              not accessed.  R is an input argument if FACT = 'F'; otherwise, R
  212.              is an output argument.  If FACT = 'F' and EQUED = 'R' or 'B',
  213.              each element of R must be positive.
  214.  
  215.      C       (input or output) REAL array, dimension (N)
  216.              The column scale factors for A.  If EQUED = 'C' or 'B', A is
  217.              multiplied on the right by diag(C); if EQUED = 'N' or 'R', C is
  218.              not accessed.  C is an input argument if FACT = 'F'; otherwise, C
  219.              is an output argument.  If FACT = 'F' and EQUED = 'C' or 'B',
  220.              each element of C must be positive.
  221.  
  222.      B       (input/output) REAL array, dimension (LDB,NRHS)
  223.              On entry, the right hand side matrix B.  On exit, if EQUED = 'N',
  224.              B is not modified; if TRANS = 'N' and EQUED = 'R' or 'B', B is
  225.              overwritten by diag(R)*B; if TRANS = 'T' or 'C' and EQUED = 'C'
  226.              or 'B', B is overwritten by diag(C)*B.
  227.  
  228.      LDB     (input) INTEGER
  229.              The leading dimension of the array B.  LDB >= max(1,N).
  230.  
  231.      X       (output) REAL array, dimension (LDX,NRHS)
  232.              If INFO = 0, the N-by-NRHS solution matrix X to the original
  233.              system of equations.  Note that A and B are modified on exit if
  234.              EQUED .ne. 'N', and the solution to the equilibrated system is
  235.              inv(diag(C))*X if TRANS = 'N' and EQUED = 'C' or or 'B'.
  236.  
  237.      LDX     (input) INTEGER
  238.              The leading dimension of the array X.  LDX >= max(1,N).
  239.  
  240.      RCOND   (output) REAL
  241.              The estimate of the reciprocal condition number of the matrix A
  242.              after equilibration (if done).  If RCOND is less than the machine
  243.              precision (in particular, if RCOND = 0), the matrix is singular
  244.              to working precision.  This condition is indicated by a return
  245.              code of INFO > 0, and the solution and error bounds are not
  246.              computed.
  247.  
  248.      FERR    (output) REAL array, dimension (NRHS)
  249.              The estimated forward error bound for each solution vector X(j)
  250.              (the j-th column of the solution matrix X).  If XTRUE is the true
  251.              solution corresponding to X(j), FERR(j) is an estimated upper
  252.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  253.              divided by the magnitude of the largest element in X(j).  The
  254.              estimate is as reliable as the estimate for RCOND, and is almost
  255.              always a slight overestimate of the true error.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))                                                          SSSSGGGGBBBBSSSSVVVVXXXX((((3333FFFF))))
  269.  
  270.  
  271.  
  272.      BERR    (output) REAL array, dimension (NRHS)
  273.              The componentwise relative backward error of each solution vector
  274.              X(j) (i.e., the smallest relative change in any element of A or B
  275.              that makes X(j) an exact solution).
  276.  
  277.      WORK    (workspace/output) REAL array, dimension (3*N)
  278.              On exit, WORK(1) contains the reciprocal pivot growth factor
  279.              norm(A)/norm(U). The "max absolute element" norm is used. If
  280.              WORK(1) is much less than 1, then the stability of the LU
  281.              factorization of the (equilibrated) matrix A could be poor. This
  282.              also means that the solution X, condition estimator RCOND, and
  283.              forward error bound FERR could be unreliable. If factorization
  284.              fails with 0<INFO<=N, then WORK(1) contains the reciprocal pivot
  285.              growth factor for the leading INFO columns of A.
  286.  
  287.      IWORK   (workspace) INTEGER array, dimension (N)
  288.  
  289.      INFO    (output) INTEGER
  290.              = 0:  successful exit
  291.              < 0:  if INFO = -i, the i-th argument had an illegal value
  292.              > 0:  if INFO = i, and i is
  293.              <= N:  U(i,i) is exactly zero.  The factorization has been
  294.              completed, but the factor U is exactly singular, so the solution
  295.              and error bounds could not be computed.  = N+1: RCOND is less
  296.              than machine precision.  The factorization has been completed,
  297.              but the matrix A is singular to working precision, and the
  298.              solution and error bounds have not been computed.
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.